<?php

/**
 * Framework_Auth_Common
 *
 * @author      Joe Stump <joe@joestump.net>
 * @copyright   (c) 2006 Joseph C. Stump. All rights reserved.
 * @license     http://www.opensource.org/licenses/bsd-license.php
 * @package Framework
 * @subpackage Auth
 * @filesource
 */

/**
 * Framework_Auth_Common
 *
 * Base class of authentication classes. Any auth class you create
 * should have a simple function named authenticate that returns a boolean
 * value. Based on the return value the controller will either load the
 * request or generate an error.
 *
 * @author Joe Stump <joe@joestump.net>
 * @package Framework
 * @see Framework_Module
 */
abstract class Framework_Auth_Common extends Framework_Object_Web
{

	

	/**
	 * __construct
	 *
	 * @access public
	 * @return void
	 */
	public function __construct()
	{
		parent::__construct();
	}

	/**
	 * authenticate
	 *
	 * Define this in your own Auth classes and have them return a boolean
	 * value. The controller will then appropriately manage the request.
	 *
	 * @abstract
	 * @access public
	 * @return boolean
	 * @see Framework::run()
	 */
	abstract public function authenticate();


}

?>